home *** CD-ROM | disk | FTP | other *** search
/ Shareware Grab Bag / Shareware Grab Bag.iso / 003 / dba1286.arc / MANUAL.TXT < prev    next >
Encoding:
Text File  |  1986-11-04  |  8.0 KB  |  146 lines
  1. CLIPBOARD by J. Ari Kornfeld
  2.  
  3. 1. Files associated with ClipBoard.
  4.    HELPGEN.OBJ--The ClipBoard object file.
  5.    UHELP.OBJ  --Universal HELP.DBF access program.
  6.    HELPGEN.DBF--The structure of a HELP.DBF type file.
  7.  
  8.    (TEMPHELP.DBF--Generated by ClipBoard.)
  9.  
  10. 2. Before using ClipBoard...
  11.    a. Use Clipper compile the finished program into object code (.OBJ).
  12.       For example, compile the file DEMO.PRG to create DEMO.OBJ.
  13.      Clipper DEMO
  14.    b. Use plink86 as shown to create two .EXE files:
  15.       Plink86  Fi DEMO  Fi UHELP  out DEMOTEST
  16.        (This will create DEMOTEST.EXE)
  17.       Plink86 Fi DEMO Fi HELPGEN  Out DEMOGEN
  18.        (This will create DEMOGEN.EXE)
  19.  
  20. 3. Using ClipBoard.
  21.    a. At the system prompt type the name of the program created by linking
  22.       HELPGEN.OBJ to the main module(s).  In our example type:
  23.         DEMOGEN
  24.    b. Strike the F1 function key to invoke ClipBoard.
  25.       note:  If the program is at a point at which it will not respond
  26.       to the F1 key, help cannot be defined for that point.
  27.     c. The first time you invoke ClipBoard, it will request the name of the
  28.        file to be used to store the help data.  It will prompt you:
  29.  
  30.         Type in the name of the .DBF file to use:
  31.  
  32.        Enter a file name without the three letter extent (.XXX). ClipBoard
  33.        will create two files with this name.  The first file will have the
  34.        extent .DBF;  the second, .NTX.  For example, type HELP--this will
  35.        tell ClipBoard to look for or create HELP.DBF and HELP.NTX.
  36.          c1.  If the files already exist, ClipBoard will give you the option
  37.              of using the data already in the files.  It will present a menu:
  38.  
  39.             Use   OverWrite  Quit
  40.  
  41.               use the arrow keys or space bar to highlight your choice.  Hit 
  42.               the return key to select it.  Use opens the existing file.
  43.               OverWrite destroys the current contents of the file. Quit
  44.               aborts ClipBoard and returns you to your application program.
  45.          c2.  If the files do not exist.  HELPGEN.DBF  MUST be present in the
  46.              current directory or Clipper will report a DOS error.
  47.          c3.  The following file names are NOT allowed:
  48.              HELPGEN,  TEMPHELP.
  49.          c4.  If you include the file extent when you type in the file name,
  50.              ClipBoard will ignore it.
  51.          c5  You may hit the escape (Esc) key to abort ClipBoard (You will
  52.              exit ClipBoard but remain in your application program.)
  53.          c6.  No distinction is made between upper and lower case letters.
  54.          c7.  You may precede the file name with a disk drive name, such
  55.               as D:HELP.
  56.     d. ClipBoard will then open a window to display the current location in
  57.        the application program and what select area was active at the
  58.        time you invoked ClipBoard.
  59.          At the bottom of the window you are presented a four choice menu:
  60.  
  61.          HelpGen   WritePrg   Help   Quit
  62.  
  63.        HelpGen is highlited.  You may use the arrow keys or space bar to
  64.        highlite a different choice.  Hit the return key to select the
  65.        currently highlited choice.  HelpGen will allow you to generate a
  66.        help window for the current procedure-variable.  WritePrg will
  67.        create a .PRG file using the information stored in the HELP.DBF
  68.        and .NTX files.  It will be discussed in more detail later.
  69.        Help provides some online help.  Quit will return you to your
  70.        application without modifying the current entry.
  71.     e. Select HelpGen.
  72.        If you already defined a help window for this procedure-variable
  73.        ClipBoard will present the following menu:
  74.  
  75.          Use   OverWrite  Quit
  76.  
  77.        If you choose to use the current information you must be careful
  78.        to save the window, even if you decide to leave it unchanged.  If
  79.        you quit beyond this point, all information about the window will
  80.        be lost.  Choosing OverWrite destroys the old information and lets
  81.        you totally redefine the help window.
  82.     f. ClipBoard is now in the "position" mode.  A "top left box corner"
  83.        will appear where the cursor was positioned at the time you hit
  84.        the F1 key.  The highest row on the screen will display a status
  85.        line showing exactly where the cursor is.  Use the arrow keys to
  86.        position the corner.
  87.          f1. Hit the F3 function key for additional help (as you can at
  88.               any time in ClipBoard.)
  89.          f2. The positioning  is not very crucial as you will get a second
  90.               chance to position the window after it has been completed.
  91.     g. Hit the F2 function key when you are satisfied.  You will now enter
  92.        the ClipBoard "edit" mode.  Type in the text of the help message.
  93.        Enter a blank line or strike the F2 function key to end the edit mode.
  94.          g1. You can use the up down and back arrows to move around the
  95.               help window.  F3 provides additional help, as before.
  96.          g2. The F9 function key will cause the message
  97.               "Press any key to continue..."
  98.               to appear and be centered on the current line in the help
  99.               window.
  100.          g3.  ClipBoard automatically puts a space between the frame and
  101.               the text both on the left and right sides.
  102.          g4.  To put a blank line in the window type a space before hitting
  103.               the return key.
  104.     h. Hit the F2 key or enter a blank line when you have finished entering
  105.        and editing the text of the help window.  This will put you into the
  106.        "verification" mode.  You can now reposition the entire window, expand
  107.        it by shifting the right side of the window to the right, kill the
  108.        entire window and start again, or resume the edit mode to redo part
  109.        of the help window.
  110.          h1.  The arrow keys move the help window around the screen.  Hit the
  111.               F3 key to see additional help.
  112.          h2.  Notice the prompt line on the bottom of the screen.
  113.          h3.  Quit will kill the window and return you to your application
  114.               program.
  115.     i.  To save the help window as it is, and return to your application
  116.         program, type S or the F1 function key.
  117.     j.  Repeat this process for all parts of the application for which you
  118.         would like to add help screens.
  119.         j1. If you would like to view the results at any point during
  120.             the development period exit the application and invoke the
  121.             version create by linking in UHELP.OBJ.  (DEMOTEST.EXE, in
  122.             our example.)  This version will also ask for a file name,
  123.             the first time you strike F1 but after that it presents
  124.             the help windows exactly as it would appear in the final
  125.             program but without allowing you to edit, etc.
  126.     k.  When you have defined all the help windows for the application
  127.         program, strike the help key (F1) from anywhere within the 
  128.         application.  Select the "WritePrg" option.  This will create a
  129.         .PRG file that can then be compiled by Clipper and linked into
  130.         your application program.  The result will work exactly the same
  131.         as the version created by linking in the UHELP.OBJ file with the
  132.         following exceptions:  It will be faster and it will no longer ask
  133.         for a file name the first time you strike F1 (it will not access
  134.         any external files at all.)
  135.         In our example, selecting the WritePrg option would create the file
  136.         HELP.PRG.
  137.          k1.  The .PRG file is given the same name as the .DBF and .NTX files
  138.               except that the extent will be .PRG.
  139.          k2.  You can use a regular text editor to alter the help.PRG file
  140.               and customize the windows' frame, color etc. to suit your
  141.               tastes.
  142. NOTES:
  143. A Hard Disk comes in very handy for this program. A RAM disk is even better.
  144. The help programs may not work properly if your application program
  145. uses the Clipper commands "SAVE SCREEN" and "RESTORE SCREEN".
  146.